<!DOCTYPE html>
<html>
<head>
    <meta http-equiv="X-UA-Compatible" content="chrome=1">
    <!--
        /**
        * o------------------------------------------------------------------------------o
        * | This file is part of the RGraph package - you can learn more at:             |
        * |                                                                              |
        * |                          http://www.rgraph.net                               |
        * |                                                                              |
        * | This package is licensed under the RGraph license. For all kinds of business |
        * | purposes there is a small one-time licensing fee to pay and for non          |
        * | commercial  purposes it is free to use. You can read the full license here:  |
        * |                                                                              |
        * |                      http://www.rgraph.net/LICENSE.txt                       |
        * o------------------------------------------------------------------------------o
        */
    -->
    <title>RGraph: Javascript charts library - Odometer charts documentation</title>
    
    <meta name="keywords" content="rgraph html5 canvas docs odometer charts" />
    <meta name="description" content="RGraph: Javascript charts library - Documentation about Odometer charts" />
    
    <meta property="og:title" content="RGraph: Javascript charts library" />
    <meta property="og:description" content="A charts library based on the HTML5 canvas tag" />
    <meta property="og:image" content="http://www.rgraph.net/images/logo.jpg"/>

    <link rel="stylesheet" href="../css/website.css" type="text/css" media="screen" />
    <link rel="icon" type="image/png" href="/favicon.png">
    
    <!-- Place this tag in your head or just before your close body tag -->
    <script type="text/javascript" src="https://apis.google.com/js/plusone.js"></script>
    
    <script src="../libraries/RGraph.common.core.js" ></script>

    <script>
      var _gaq = _gaq || [];
      _gaq.push(['_setAccount', 'UA-54706-2']);
      _gaq.push(['_trackPageview']);
    
      (function() {
        var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
        ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
        var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
      })();
    </script>

</head>
<body>

    <!-- Social networking buttons -->
        <div id="social_icons" class="warning" style="border-radius: 10px; top: 1px; position: fixed; width: 140px; height: 20px">
            <a title="Bookmark with delicious" href="http://delicious.com/save?jump=close&v=4&noui&jump=close&url=http://www.rgraph.net&notes=RGraph%20is%20a%20HTML5%20based%20javascript%20charts%20library%20supporting%20a%20wide%20range%20of%20different%20chart%20types&title=RGraph:%20Javascript%20charts%20%26%20graph%20library" target="_blank"><img src="../images/delicious.png" alt="Bookmark with delicious" width="22" height="22" border="0" style="position: relative; top: 1px" /></a>
            <a href="http://www.twitter.com/_RGraph" target="_blank" title="Follow _RGraph on Twitter"><img src="../images/twitter.png" alt="Follow _RGraph on Twitter"/></a>
            <iframe src="http://www.facebook.com/plugins/like.php?app_id=253862424642173&amp;href=http%3A%2F%2Fwww.rgraph.net&amp;send=false&amp;layout=button_count&amp;width=450&amp;show_faces=false&amp;action=like&amp;colorscheme=light&amp;font=arial&amp;height=21" scrolling="no" frameborder="0" style="width: 80px; height:21px; position: relative; top: 1px"></iframe>
        </div>
        
        <script>
            // Opera fix
            if (navigator.userAgent.indexOf('Opera') == -1) {
              document.getElementById("social_icons").style.position = 'fixed';
            }
        </script>
        
        <div id="google_plusone">
            <!-- Place this tag where you want the +1 button to render -->
            <g:plusone href="http://www.rgraph.net"></g:plusone>
        </div>
    <!-- Social networking buttons -->

    <div id="breadcrumb">
        <a href="../index.html">RGraph: Javascript charts library</a>
        >
        <a href="index.html">Documentation</a>
        >
        Odometer charts
    </div>

    <h1>RGraph: <span>Javascript charts library</span> - Odometer charts documentation</h1>

    <script>
        if (RGraph.isIE8()) {
            document.write('<div style="background-color: #fee; border: 2px dashed red; padding: 5px"><b>Important</b><br /><br /> Internet Explorer 8 does not natively support the HTML5 canvas tag, so if you want to see the charts, you can either:<ul><li>Install <a href="http://code.google.com/chrome/chromeframe/">Google Chrome Frame</a></li><li>Use ExCanvas. This is provided in the RGraph Archive.</li><li>Use another browser entirely. Your choices are Firefox 3.5+, Chrome 2+, Safari 4+ or Opera 10.5+. </li></ul> <b>Note:</b> Internet Explorer 9 fully supports the canvas tag.</div>');
        }
    </script>
    
    <p> 
        The example file is <a href="../examples/odo.html">here</a>.
    </p> 
    
    <pre class="code">
&lt;script&gt;
    window.onload = function ()
    {
        // ID, MINIMUM, MAXIMUM, INDICATED VALUE
        var odo = new RGraph.Odometer('myOdo', 0, 100, 18);
        
        odo.Set('chart.green.max', 75);
        odo.Set('chart.red.min', 90);
        odo.Set('chart.label.area', 50);
        odo.Set('chart.needle.thickness', 2);
    
        odo.Draw();
    }
&lt;/script&gt;
</pre>
    
    <!--
        <div class="warning">
            <p>Note</p>
             As of 20th March 2010, how you specify the start and end values has changed. The chart.green.start, chart.green.end, chart.yellow.start,
             chart.yellow.end, chart.red.start and chart.red.end have all been replaced by chart.green.max and chart.red.min. Now the
             green area always starts at zero and goes to chart.green.max, and the red area starts (by default - you can customise this by using
             chart.red.min) at 90% of the maximum value and goes to the maximum value. The yellow area is between the two.
        </div>
    -->

    <h2>Properties</h2>
    
    <p>
        You can use these properties to control how the Odometer apears. You can set these properties using the <b>Set()</b> method.
    </p>
    
    <ul>
        <li><a href="#chart configuration">Chart configuration</a></li>
        <li><a href="#margins">Margins</a></li>
        <li><a href="#colors">Colors</a></li>
        <li><a href="#labels and text">Labels and text</a></li>
        <li><a href="#needle">Needle</a></li>
        <li><a href="#title">Title</a></li>
        <li><a href="#shadow">Shadow</a></li>
        <li><a href="#interactive features">Interactive features</a></li>
        <li><a href="#zoom">Zoom</a></li><li><a href="#scale">Scale</a></li>
    </ul>


<a name="chart configuration"></a>
<h3 style="border: 1px solid #aaa; background-color: #eee; font-style: italic; padding: 5px; -moz-border-radius: 10px; -webkit-border-radius: 10px; border-radius: 10px">Chart configuration</h3>

            <a name="chart.value.text"></a>
            <b>chart.value.text</b><br />
            Controls whether the value is indicated as a text label in the center of the dial.<br /><i>Default: false</i><br /><br />
            
            <a name="chart.value.units.pre"></a>
            <b>chart.value.units.pre</b><br />
            The pre units used on the textual value.<br /><i>Default: nothing (An empty string)</i><br /><br />
            
            <a name="chart.value.units.post"></a>
            <b>chart.value.units.post</b><br />
            The post units used on the textual value.<br /><i>Default: nothing (An empty string)</i><br /><br />
            
            <a name="chart.border"></a>
            <b>chart.border</b><br />
            This controls the gray border of the Odometer.<br /><i>Default: false</i><br /><br />
            
            <a name="chart.tickmarks.highlighted"></a>
            <b>chart.tickmarks.highlighted</b><br />
            This controls whether the tickmarks are highlighted in red/yellow/green.<br /><i>Default: false</i><br /><br />
            
            <a name="chart.zerostart"></a>
            <b>chart.zerostart</b><br />
            If you want the top value on your chart to be zero instead of the maximum value, set this to true.<br /><i>Default: false</i><br /><br />

<a name="margins"></a>
<h3 style="border: 1px solid #aaa; background-color: #eee; font-style: italic; padding: 5px; -moz-border-radius: 10px; -webkit-border-radius: 10px; border-radius: 10px">Margins</h3>
            



            <a name="chart.gutter.left"></a>
            <b>chart.gutter.left</b><br />
            The left gutter of the chart, (the gutter is where the labels and title are)).<br />
            <i>Default: 25</i><br /><br />

            <a name="chart.gutter.right"></a>
            <b>chart.gutter.right</b><br />
            The right gutter of the chart, (the gutter is where the labels and title are).<br />
            <i>Default: 25</i><br /><br />

            <a name="chart.gutter.top"></a>
            <b>chart.gutter.top</b><br />
            The top gutter of the chart, (the gutter is where the labels and title are).<br />
            <i>Default: 25</i><br /><br />

            <a name="chart.gutter.bottom"></a>
            <b>chart.gutter.bottom</b><br />
            The bottom gutter of the chart, (the gutter is where the labels and title are).<br />
            <i>Default: 25</i><br /><br />

<a name="colors"></a>
<h3 style="border: 1px solid #aaa; background-color: #eee; font-style: italic; padding: 5px; -moz-border-radius: 10px; -webkit-border-radius: 10px; border-radius: 10px">Colors</h3>
            
            <a name="chart.border.color1"></a>
            <b>chart.border.color1</b><br />
            This is the first color used in the gradient of the outer border of the chart (if enabled).<br />
            <i>Default: #BEBCB0</i><br /><br />
            
            <a name="chart.border.color2"></a>
            <b>chart.border.color2</b><br />
            This is the second/middle color used in the gradient of the outer border of the chart (if enabled).<br />
            <i>Default: #F0EFEA</i><br /><br />
            
            <a name="chart.border.color3"></a>
            <b>chart.border.color3</b><br />
            This is the third color used in the gradient of the outer border of the chart (if enabled).<br />
            <i>Default: #BEBCB0</i><br /><br />

            <a name="chart.green.max"></a>
            <b>chart.green.max</b><br />
            This is the point at which the green area ends.<br />
            <i>Default: 75% of the maximum value</i><br /><br />

            <a name="chart.red.min"></a>
            <b>chart.red.min</b><br />
            This is the point at which the red area starts. The yellow area is between the green and red areas.<br />
            <i>Default: 90% of the maximum value</i><br /><br />

            <a name="chart.green.color"></a>
            <b>chart.green.color</b><br />
            This option has two roles. If <i>chart.green.solid</i> is true, this is the actual color, whereas if
            <i>chart.green.solid</i> is false (the default), it's used as one of the gradient colors.<br />
            <i>Default: green</i><br /><br />

            <a name="chart.yellow.color"></a>
            <b>chart.yellow.color</b><br />
            This option has two roles. If <i>chart.yellow.solid</i> is true, this is the actual color, whereas if
            <i>chart.yellow.solid</i> is false (the default), it's used as one of the gradient colors.<br />
            <i>Default: yellow</i><br /><br />

            <a name="chart.red.color"></a>
            <b>chart.red.color</b><br />
            This option has two roles. If <i>chart.red.solid</i> is true, this is the actual color, whereas if
            <i>chart.red.solid</i> is false (the default), it's used as one of the gradient colors.<br />
            <i>Default: red</i><br /><br />

            <a name="chart.green.solid"></a>
            <b>chart.green.solid</b><br />
            If <i>true</i> then the associated <i>chart.green.color</i> option is used as the  actual color, not part of a gradient<br />
            <i>Default: false</i><br /><br />

            <a name="chart.yellow.solid"></a>
            <b>chart.yellow.solid</b><br />
            If <i>true</i> then the associated <i>chart.yellow.color</i> option is used as the  actual color, not part of a gradient<br />
            <i>Default: false</i><br /><br />

            <a name="chart.red.solid"></a>
            <b>chart.red.solid</b><br />
            If <i>true</i> then the associated <i>chart.red.color</i> option is used as the  actual color, not part of a gradient<br />
            <i>Default: false</i><br /><br />

<a name="labels and text"></a>
<h3 style="border: 1px solid #aaa; background-color: #eee; font-style: italic; padding: 5px; -moz-border-radius: 10px; -webkit-border-radius: 10px; border-radius: 10px">Labels and text</h3>            <a name="chart.labels"></a>
<b>chart.labels</b><br />
            Instead of using computed numbers, which uses the maximum value, you can specify the Odometer to use textual labels instead, with this option.<br /> <i>Default: null</i><br /><br />
            <a name="chart.label.area"></a>
<b>chart.label.area</b><br />
            The width of the area that labels are put in. <br /><i>Default: 35</i><br /><br />
            <a name="chart.text.size"></a>
<b>chart.text.size</b><br />
            The size of the text (in points). <br /><i>Default: 10</i><br /><br />
            <a name="chart.text.font"></a>
<b>chart.text.font</b><br />
            The font used to render the text.<br /><i>Default: Verdana</i><br /><br />
            <a name="chart.text.color"></a>
<b>chart.text.color</b><br />
            The color of the labels. <br /><i>Default: black</i><br /><br />
<a name="needle"></a>
<h3 style="border: 1px solid #aaa; background-color: #eee; font-style: italic; padding: 5px; -moz-border-radius: 10px; -webkit-border-radius: 10px; border-radius: 10px">Needle</h3>            <a name="chart.needle.width"></a>
<b>chart.needle.width</b><br />
            How thick the needle is. <br /><i>Default: 2</i><br /><br />
            <a name="chart.needle.color"></a>
<b>chart.needle.color</b><br />
            The color that is applied to the needle. <br /><i>Default: black</i><br /><br />
            <a name="chart.needle.head"></a>
<b>chart.needle.head</b><br />
            This controls whether the arrow head on the end of the needle is displayed. <br /><i>Default: true</i><br /><br />
            
            <a name="chart.needle.type"></a>
            <b>chart.needle.type</b><br />
            This determines which type of needle is used. It can be <i>pointer</i> or <i>triangle</i>. <br />
            <i>Default: pointer</i><br /><br />
            
            <a name="chart.needle.triangle.border"></a>
            <b>chart.needle.triangle.border</b><br />
            This controls the colour of the border for the pointer. If you don't want it you could set it to be transparent -
            <i>rgba(0,0,0,0)</i>.<br />
            <i>Default: #aaa</i><br /><br />
            
            <a name="chart.needle.extra"></a>
            <b>chart.needle.extra</b><br />
            With this you can specify a number of extra pointers that will be drawn on the Odometer. An example would be a meter that's used to show upload and download data. An example use:<pre class="code">odo.Set('chart.needle.extra', [[16, 'red'], [24, 'blue']]);</pre><br />
            <i>Default: [] (An empty array)</i><br /><br />

<a name="title"></a>
<h3 style="border: 1px solid #aaa; background-color: #eee; font-style: italic; padding: 5px; -moz-border-radius: 10px; -webkit-border-radius: 10px; border-radius: 10px">Title</h3>            <a name="chart.title"></a>
<b>chart.title</b><br />
            The title text. <br /><i>Default: no title set</i><br /><br />

<a name="chart.title.background"></a>
<b>chart.title.background</b><br />
The background color (if any) for the title.<br />
<i>Default: null</i><br /><br />

            <a name="chart.title.color"></a>
<b>chart.title.color</b><br />
            The color of the title.<br /> <i>Default: black</i><br /><br />
            <a name="chart.title.hpos"></a>
<b>chart.title.hpos</b><br />
            This allows you to completely override the horizontal positioning of the title. It should be a number between 0 and 1, and is multiplied with the whole width of the canvas and then used as the horizontal position. <br /><i>Default: null</i><br /><br />
            <a name="chart.title.vpos"></a>
<b>chart.title.vpos</b><br />
            This allows you to completely override the vertical positioning of the title. It should be a number between 0 and 1, and is multiplied with the gutter and then used as the vertical position. It can be useful if you need to have a large gutter.<br /><i>Default: null</i><br /><br />
<a name="shadow"></a>
<h3 style="border: 1px solid #aaa; background-color: #eee; font-style: italic; padding: 5px; -moz-border-radius: 10px; -webkit-border-radius: 10px; border-radius: 10px">Shadow</h3>            <a name="chart.shadow.inner"></a>
<b>chart.shadow.inner</b><br />
            Whether a drop shadow is applied to the inner circle of the Odometer<br /><i>Default: false</i><br /><br />
            <a name="chart.shadow.outer"></a>
<b>chart.shadow.outer</b><br />
            Whether a drop shadow is applied to the whole Odometer.<br /><i>Default: false</i><br /><br />
<a name="interactive features"></a>
<h3 style="border: 1px solid #aaa; background-color: #eee; font-style: italic; padding: 5px; -moz-border-radius: 10px; -webkit-border-radius: 10px; border-radius: 10px">Interactive features</h3>            <a name="chart.contextmenu"></a>
<b>chart.contextmenu</b><br />
            An array of context menu items. More information on context menus is <a href="context.html">here</a>.<br /><i>Default: [] (An empty array)</i><br /><br />
            <a name="chart.annotatable"></a>
<b>chart.annotatable</b><br />
            Whether annotations are enabled for the chart (ie you can draw on the chart interactively.<br /><i>Default: false</i><br /><br />
            <a name="chart.annotate.color"></a>
<b>chart.annotate.color</b><br />
            If you do not allow the use of the palette, then this will be the only colour allowed for annotations.<br /><i>Default: black</i><br /><br />



            <a name="chart.resizable"></a>
            <b>chart.resizable</b><br />
            Defaulting to false, this determines whether your chart will be resizable. Because of the numerous event handlers this has to install code on, This feature is unlikely to work with other dynamic features (the context menu is fine however).<br />
            <i>Default: false</i><br /><br />


            <a name="chart.resize.handle.background"></a>
            <b>chart.resize.handle.background</b><br />
            With this you can specify the background color for the resize handle. If you're adjusting the position of the
            handle then you may need this to make the handle stand out more.<br />
            <i>Default: null</i><br /><br />


<a name="zoom"></a>
<h3 style="border: 1px solid #aaa; background-color: #eee; font-style: italic; padding: 5px; -moz-border-radius: 10px; -webkit-border-radius: 10px; border-radius: 10px">Zoom</h3>            <a name="chart.zoom.mode"></a>
<b>chart.zoom.mode</b><br />
            Can be used to control whether the zoom is in thumbnail or canvas mode. Possible values are: <i>thumbnail</i> and <i>canvas</i>.<br /><i>Default: canvas</i><br /><br />
            <a name="chart.zoom.factor"></a>
<b>chart.zoom.factor</b><br />
            This is the factor that the chart will be zoomed by (bigger values means more zoom)<br /><i>Default: 1.5</i><br /><br />
            <a name="chart.zoom.fade.in"></a>
<b>chart.zoom.fade.in</b><br />
            Whether the zoomed canvas fades in or not. This also can be used to control the fade in for the zoom in thumbnail mode.<br /><i>Default: true</i><br /><br />
            <a name="chart.zoom.fade.out"></a>
<b>chart.zoom.fade.out</b><br />
            Whether the zoomed canvas fades out or not. This also can be used to control the fade in for the zoom in thumbnail mode.<br /><i>Default: true</i><br /><br />
            <a name="chart.zoom.hdir"></a>
<b>chart.zoom.hdir</b><br />
            The horizontal direction of the zoom. Possible values are: <i>left</i>, <i>center</i>, <i>right</i><br /><i>Default: right</i><br /><br />
            <a name="chart.zoom.vdir"></a>
<b>chart.zoom.vdir</b><br />
            The vertical direction of the zoom. Possible values are: <i>up</i>, <i>center</i>, <i>down</i><br /><i>Default: down</i><br /><br />
            <a name="chart.zoom.delay"></a>
<b>chart.zoom.delay</b><br />
            The delay (in milliseconds) between frames.<br /><i>Default: 50</i><br /><br />
            <a name="chart.zoom.frames"></a>
<b>chart.zoom.frames</b><br />
            The number of frames in the zoom animation.<br /><i>Default: 10</i><br /><br />
            <a name="chart.zoom.shadow"></a>
<b>chart.zoom.shadow</b><br />
            Whether or not the zoomed canvas has a shadow or not.<br /><i>Default: true</i><br /><br />
            <a name="chart.zoom.thumbnail.width"></a>
<b>chart.zoom.thumbnail.width</b><br />
            When the zoom is in thumbnail mode, this is the width (in pixels) of the thumbnail.<br /><i>Default: 75</i><br /><br />
            <a name="chart.zoom.thumbnail.height"></a>
<b>chart.zoom.thumbnail.height</b><br />
            When the zoom is in thumbnail mode, this is the height (in pixels) of the thumbnail.<br /><i>Default: 75</i><br /><br />
            <a name="chart.zoom.background"></a>
<b>chart.zoom.background</b><br />
            Defaulting to true, this determines whether the zoom has a dark, semi-opaque background that covers the entire web page.<br /><i>Default: true</i><br /><br />
<a name="scale"></a>
<h3 style="border: 1px solid #aaa; background-color: #eee; font-style: italic; padding: 5px; -moz-border-radius: 10px; -webkit-border-radius: 10px; border-radius: 10px">Scale</h3>

            <a name="chart.units.pre"></a>
            <b>chart.units.pre</b><br />
            The units that the value is measured in. This string is displayed BEFORE the actual number, allowing you to specify values such as "$50" and is only used if chart.value.text is <i>true</i>.<br /><i>Default: none</i><br /><br />
            
            <a name="chart.units.post"></a>
            <b>chart.units.post</b><br />
            The units that the value is measured in. This string is displayed AFTER the actual number, allowing you to specify values such as "50ms" and is only used if chart.value.text is <i>true</i>.<br /><i>Default: none</i><br /><br />

            <a name="chart.scale.decimals"></a>
<b>chart.scale.decimals</b><br />
            The number of decimal places to display for the labels.<br /><i>Default: 0</i><br /><br />
</div><!-- /DOCS --><br /><br />

</body>
</html>